vcEvent

vcEvent provides a way to register event handlers for different events. Event becomes invalid when the source of events is deleted. Accessing properties or methods of this event will raise a ValueError telling that event has been invalidated. It is possible to use "IsValid" property to check the state, without raising an exception.

See in: Overview

Module: vcCore

Parent: -

Children -

Referenced by: -

Properties

Learn how to use properties here. The properties are also inherited from the parent class.

Name	Type	Access	Description
IsValid	Boolean	R	Gets a value that defines if the object contained in this event is still valid.

Methods

Learn how to use methods here. The methods are also inherited from the parent class.

Name	Return Type	Parameters	Description
reset	None	None	Removes all registered event handlers.
wait	object	Optional Keyword[filter = Callable]	Blocks script execution until an event has been triggered. See more This function returns an awaitable task. It must be awaited. Parameters: Optional: filter (function): User-defined function that evaluates event arguments and returns True whenever the script can continue its execution. Returns: Awaitable[List]: The task instance. When awaited, returns a list of event arguments that the event has been triggered with. When "filter" is specified, only arguments that pass the filter are returned.